/*
 * ==========================================================================================
 * =                   JAHIA'S DUAL LICENSING - IMPORTANT INFORMATION                       =
 * ==========================================================================================
 *
 *                                 http://www.jahia.com
 *
 *     Copyright (C) 2002-2020 Jahia Solutions Group SA. All rights reserved.
 *
 *     THIS FILE IS AVAILABLE UNDER TWO DIFFERENT LICENSES:
 *     1/GPL OR 2/JSEL
 *
 *     1/ GPL
 *     ==================================================================================
 *
 *     IF YOU DECIDE TO CHOOSE THE GPL LICENSE, YOU MUST COMPLY WITH THE FOLLOWING TERMS:
 *
 *     This program is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU General Public License as published by
 *     the Free Software Foundation, either version 3 of the License, or
 *     (at your option) any later version.
 *
 *     This program is distributed in the hope that it will be useful,
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *     GNU General Public License for more details.
 *
 *     You should have received a copy of the GNU General Public License
 *     along with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 *
 *     2/ JSEL - Commercial and Supported Versions of the program
 *     ===================================================================================
 *
 *     IF YOU DECIDE TO CHOOSE THE JSEL LICENSE, YOU MUST COMPLY WITH THE FOLLOWING TERMS:
 *
 *     Alternatively, commercial and supported versions of the program - also known as
 *     Enterprise Distributions - must be used in accordance with the terms and conditions
 *     contained in a separate written agreement between you and Jahia Solutions Group SA.
 *
 *     If you are unsure which license is appropriate for your use,
 *     please contact the sales department at sales@jahia.com.
 */
package org.jahia.taglibs.search.facets;

import java.util.Collection;
import java.util.Collections;

/**
 * Represents facet data for using in a JSP view.
 * 
 * @author Sergiy Shyrkov
 * 
 * @since 7.2.3.1
 */
public class FacetData {

    private Collection<String> activeValues = Collections.emptySet();

    private String parameterNameRegex;

    private String valueParameterName;

    /**
     * Initializes an instance of this class.
     */
    FacetData() {
        super();
    }

    /**
     * Returns a collection of currently active values for this face, based on corresponding request parameter values.
     * 
     * @return a collection of currently active values for this facet or an empty collections if there are no active values
     */
    public Collection<String> getActiveValues() {
        return activeValues;
    }

    /**
     * The regular expression for the request parameter names of this facet (used in calculating the drilldown URL).
     * 
     * @return regular expression for the request parameter names of this facet (used in calculating the drilldown URL)
     */
    public String getParameterNameRegex() {
        return parameterNameRegex;
    }

    /**
     * Returns the name of the request parameter, this facet is using to submit its active values.
     * 
     * @return the name of the request parameter, this facet is using to submit its active values
     */
    public String getValueParameterName() {
        return valueParameterName;
    }

    void setActiveValues(Collection<String> activeValues) {
        this.activeValues = activeValues != null ? activeValues : Collections.emptySet();
    }

    void setParameterNameRegex(String parameterNameRegex) {
        this.parameterNameRegex = parameterNameRegex;
    }

    void setValueParameterName(String valueParameterName) {
        this.valueParameterName = valueParameterName;
    }

}
